All Packages Class Hierarchy This Package Previous Next Index
Object | +----com.symantec.itools.vcafe.openapi.VisualProject
VisualProject
to work with, use one of the following VisualCafe
methods:getProjects()
to get all open projects,
getTargetProject()
to get the currently active project,
getProject()
to get an open project with a given name,
openProject()
to open a project,
createProject()
to create a new project,
createEmptyProject()
to create a new empty project, or
createDefaultProject()
to create a new project from the default project template.
VisualProject
's abstract methods first calls
checkValidity(). Any method could therefore throw an InvalidVisualProjectException
.
This exception extends RuntimeException
, so doesn't have to be explicity declared or
caught. A VisualProject
can become invalid if it is closed, and the corresponding
ProjectListener
message is ignored, for example.
addFile
"enableRAD" value indicating the file should added with RAD set to the default
value for the project.
addFile
"enableRAD" value indicating the file should added with RAD disabled.
addFile
"enableRAD" value indicating the file should added with RAD enabled.
addFile
"updateProjectBeans" value indicating that after the file is added, the user should be prompted
about updating project beans.
addFile
"updateProjectBeans" value indicating that after the file is added, project beans should be
NOT be updated.
addFile
"updateProjectBeans" value indicating that after the file is added, project beans should be
updated.
aboutToChangeProjectEntries()
message to be
sent to all ProjectListeners
registered to this project.
DTListener
to this project.
VisualProject
.
VisualProject
.
VisualProject
.
VisualProject
corresponds to a valid project in Visual Cafe.
VisualProject
.
VisualProject
.
VisualProject
.
doneChangingProjectEntries()
message to be
sent to all ProjectListeners
registered to this project.
Attributes
object that allows project-related named value storage.
ClassLoader
for objects/classes in this project.
DTClass
object associated with the class
with the given string name.
File
associated with this VisualProject
file.
VisualObjects
.
ProjectFile
that corresponds to the file with the given name.
ProjectFile
that corresponds to the file id.
VisualProject
corresponds to a valid project in Visual Cafe.
DTListener
from this project.
ProjectFile
from this project.
ProjectFile
from this project.
DTClass
information.
VisualProject
.
VisualProject
to a new name.
VisualProject
's contents modified.
DTClass
information.
String
that represents this object.
public static final int ENABLE_RAD_DEFAULT
addFile
"enableRAD" value indicating the file should added with RAD set to the default
value for the project.
public static final int ENABLE_RAD_OFF
addFile
"enableRAD" value indicating the file should added with RAD disabled.
public static final int ENABLE_RAD_ON
addFile
"enableRAD" value indicating the file should added with RAD enabled.
public static final int FILES_TAB
public static final int OBJECTS_TAB
public static final int PACKAGES_TAB
public static final int UPDATE_PROJECT_BEANS_ASK
addFile
"updateProjectBeans" value indicating that after the file is added, the user should be prompted
about updating project beans.
public static final int UPDATE_PROJECT_BEANS_NO
addFile
"updateProjectBeans" value indicating that after the file is added, project beans should be
NOT be updated.
public static final int UPDATE_PROJECT_BEANS_YES
addFile
"updateProjectBeans" value indicating that after the file is added, project beans should be
updated.
public VisualProject()
public abstract void aboutToChangeProjectEntries()
aboutToChangeProjectEntries()
message to be
sent to all ProjectListeners
registered to this project.
public abstract void addDTListener(DTListener listener)
DTListener
to this project.
Changes to this project's Design-Time Reflection classes are broadcast to the listeners registered with it.
To be notified of changes, a plug-in implements the com.symantec.itools.vcafe.openapi.dtreflect.DTListener
interface, then calls this method to place itself on the notification list. When this VisualProject
's
Design-Time Reflection information changes, the listener is called.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile addFile(File file)
VisualProject
.
ProjectFile
object.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile addFile(String fileName, boolean makeRelative, int enableRAD, int updateProjectBeans)
VisualProject
.
ProjectFile
object.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile addFile(String fileName, int addedBy, boolean makeRelative)
VisualProject
.
ProjectFile
object.
public abstract void addProjectListener(ProjectListener projectListener)
ProjectListener
interface, then calls
this method to place itself on the notification list. When this VisualProject
changes, the
appropriate listener method is called.
public void checkValidity() throws InvalidVisualProjectException
VisualProject
corresponds to a valid project in Visual Cafe.
Note that the implementation of all of VisualProject
's abstract methods first call
checkValidity(). Any method could therefore throw an InvalidVisualProjectException
.
public abstract void close()
VisualProject
.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile createFile(String fileName, String contents, int enableRAD)
VisualProject
. The file will be created relative to the project's
location.
ProjectFile
.
ProjectFile
object.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile createFile(String fileName, byte contents, int enableRAD)
VisualProject
. The file will be created relative to the project's
location.
ProjectFile
.
ProjectFile
object.
public abstract void createNewInteraction(VisualObject from, VisualObject to)
The method returns before editing begins. There is no guarantee that an interaction involving the objects specified will result, e.g., the user may cancel the interaction or specify other from and to objects. If called while the wizard is running (not likely because the wizard is modal, but possible) the wizard will queue the request to be performed after the current session is completed.
VisualObject
that fires the event; must not be null
.
VisualObject
that is affected by the interaction;
may be null
.
public abstract void createNewInteraction(VisualObject from, VisualObject to, boolean useEditor)
Same as above except sets the interaction editor preference based on the preferEditor argument. The editor preference applies to all subsequent createNewInteraction calls without the third argument, in any project.
VisualObject
that fires the event; must not be null
.
VisualObject
that is affected by the interaction;
may be null
.
true
if the interaction editor is to be used,
false
if the interaction wizard is to be used.
public abstract void doneChangingProjectEntries()
doneChangingProjectEntries()
message to be
sent to all ProjectListeners
registered to this project.
public abstract void execute()
public abstract com.symantec.itools.vcafe.openapi.Attributes getAttributes()
Attributes
object that allows project-related named value storage.
The values stored in the returned Attributes
object are assoicated with this
specific VisualProject
, not with the Visual Cafe program in general. To create
global name values (not specific to any one project), use VisualCafe
's
getAttributes
method.
Attributes
storage object.
public abstract com.symantec.itools.vcafe.openapi.BuildManager getBuildManager()
BuildManager
public abstract java.lang.ClassLoader getClassLoader()
ClassLoader
for objects/classes in this project.
ClassLoader
.
public abstract com.symantec.itools.vcafe.openapi.dtreflect.DTClass getDTClassObject(String className)
DTClass
object associated with the class
with the given string name.
DTClass
object for the class.
public abstract java.net.URL getDocumentBase() throws MalformedURLException
public abstract java.io.File getFile()
File
associated with this VisualProject
file.
VisualProject
's File
.
public abstract com.symantec.itools.vcafe.openapi.VisualRepository getObjectLibrary()
VisualObjects
.
public abstract com.symantec.itools.vcafe.openapi.options.ProjectOptionSet getOptionSet()
ProjectOptionSet
allows access to the options for this project.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile getProjectFile(String fileName)
ProjectFile
that corresponds to the file with the given name.
If the file isn't in this project, null
is returned.
ProjectFile
object, or null
if not found.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile getProjectFile(int projectFileID)
ProjectFile
that corresponds to the file id.
If the file isn't in this project, null
is returned.
ProjectFile
object, or null
if not found.
public abstract com.symantec.itools.vcafe.openapi.ProjectFile[] getProjectFiles()
ProjectFile
objects
public abstract com.symantec.itools.vcafe.openapi.ProjectFile[] getProjectFiles(int addedBy)
ProjectFile
objects
public abstract java.lang.String getProjectName()
public abstract int getProjectType()
public abstract com.symantec.itools.vcafe.openapi.ProjectFile[] getSelectedFiles()
ProjectFile
objects.
public abstract com.symantec.itools.vcafe.openapi.VisualObject[] getSelectedObjects()
VisualObject
objects.
public abstract int getSelectedTab()
public abstract boolean isValid()
VisualProject
corresponds to a valid project in Visual Cafe.
true
if so, false
otherwise.
public abstract void parseOutstandingFiles()
public abstract void removeDTListener(DTListener listener)
DTListener
from this project. Stops the listener from receiving notifications of
changes to this project's Design-Time Reflection classes.
public abstract void removeFile(ProjectFile file)
ProjectFile
from this project.
ProjectFile
to remove.
public abstract void removeFile(File file)
ProjectFile
from this project.
public abstract void removeProjectListener(ProjectListener projectListener)
public abstract void renameFile(ProjectFile file, String newName, boolean replace)
ProjectFile
that will be renamed.
true
to overwrite any file that might already have the new name.
public abstract void resumeBackgroundParser(boolean bringUpToDate)
DTClass
information.
DTClass
information.
public abstract void runInDebugger()
public abstract void save()
VisualProject
.
public abstract void saveAs(File newFile)
VisualProject
to a new name.
VisualProject
.
public abstract void setModified()
VisualProject
's contents modified.
This can be useful if you save persistent attributes in response to
ProjectListener.aboutToSaveProject()
.
public abstract void setProjectType(int projectType)
public abstract void setSelectedTab(int selectedTab)
public abstract void suspendBackgroundParser(boolean bringUpToDate)
DTClass
information.
true
, make sure the state of the DTClass
information is
brought up to date before suspending the parser.
This method must be matched by a call to resumeBackgroundParser()
.
example usage:
visualProject.suspendBackgroundParser(false);
try {
...
... lots of processing here that causes parsing ...
...
} finally {
visualProject.resumeBackgroundParser(true);
}
public java.lang.String toString()
String
that represents this object.
String
,
public abstract void updateProjectBeans()
All Packages Class Hierarchy This Package Previous Next Index